<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qdoc-manual-qdocconf.qdoc -->
  <title>Generating DITA XML Output | QDoc Manual 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >Generating DITA XML Output</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qdoc-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
  <link rel="prev" href="21-1-minimum-qdocconf.html" />
  <link rel="next" href="28-qdoc-qa-pages.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="21-1-minimum-qdocconf.html">minimum.qdocconf</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="28-qdoc-qa-pages.html">QA Pages</a>
</p><p/>
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Generating DITA XML Output</h1>
<span class="subtitle"></span>
<!-- $$$21-3-qt-dita-xml-output.html-description -->
<div class="descr"> <a name="details"></a>
<p>QDoc can generate <a href="http://dita.xml.org">DITA XML output</a>.</p>
<p>In your configuration file, set your <code>outputformats</code> variable to <code>DITAXML</code>, and send the output to an appropriate directory:</p>
<pre class="cpp plain">

  outputdir                  = $QTDIR/doc/ditaxml
  outputformats              = DITAXML

</pre>
<p>And include these macros in your configuration file to prevent QDoc from doing some escaping that doesn't validate in XML:</p>
<pre class="cpp plain">

  macro.aacute.DITAXML       = &quot;&amp;aacute;&quot;
  macro.Aring.DITAXML        = &quot;&amp;Aring;&quot;
  macro.aring.DITAXML        = &quot;&amp;aring;&quot;
  macro.Auml.DITAXML         = &quot;&amp;Auml;&quot;
  macro.br.DITAXML           = &quot; &quot;
  macro.BR.DITAXML           = &quot; &quot;
  macro.copyright.DITAXML    = &quot;&amp;copy;&quot;
  macro.eacute.DITAXML       = &quot;&amp;eacute;&quot;
  macro.hr.DITAXML           = &quot; &quot;
  macro.iacute.DITAXML       = &quot;&amp;iacute;&quot;
  macro.oslash.DITAXML       = &quot;&amp;oslash;&quot;
  macro.ouml.DITAXML         = &quot;&amp;ouml;&quot;
  macro.raisedaster.DITAXML  = &quot;&lt;sup&gt;*&lt;/sup&gt;&quot;
  macro.rarrow.DITAXML       = &quot;&amp;rarr;&quot;
  macro.reg.DITAXML          = &quot;&lt;sup&gt;&amp;reg;&lt;/sup&gt;&quot;
  macro.uuml.DITAXML         = &quot;&amp;uuml;&quot;
  macro.mdash.DITAXML        = &quot;&amp;mdash;&quot;
  macro.emptyspan.DITAXML    = &quot; &quot;

</pre>
<p>You can also set default values for some of the tags in the DITA <code>&lt;prolog&gt;</code> and <code>&lt;metadata&gt;</code> elements:</p>
<pre class="cpp plain">

  dita.metadata.default.author      = Qt Development Frameworks
  dita.metadata.default.permissions = all
  dita.metadata.default.publisher   = Qt Project
  dita.metadata.default.copyryear = 2020
  dita.metadata.default.copyrholder = Qt Project
  dita.metadata.default.audience = programmer

</pre>
<p>See the <a href="12-0-qdoc-commands-miscellaneous.html#meta-command">\meta</a> command for more details on DITA metadata.</p>
</div>
<!-- @@@21-3-qt-dita-xml-output.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="21-1-minimum-qdocconf.html">minimum.qdocconf</a>
<span class="naviSeparator">  &#9702;  </span>
<a class="nextPage" href="28-qdoc-qa-pages.html">QA Pages</a>
</p>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
